home *** CD-ROM | disk | FTP | other *** search
/ Programming Languages Suite / ProgramD2.iso / T U R B O Language / Turbo Pascal V7.0 / ONLINE.ZIP / MANUAL.TV next >
Text File  |  1992-10-30  |  14KB  |  359 lines
  1. Turbo Vision 2.0 Programming Guide
  2. ==================================
  3.  
  4. This file contains information on material added to Turbo Vision
  5. 2.0 after the Programming Guide had gone to press and also
  6. corrections to a few errors in the manual.  We strongly suggest
  7. that you mark these corrections and changes in your manual for
  8. future reference.
  9.  
  10.  
  11. =============================================================
  12. Changes and additions to Chapter 19, "Turbo Vision Reference"
  13. =============================================================
  14.  
  15. =============================================================
  16. CreateFindDialog function                             Editors
  17. =============================================================
  18.  
  19.        Declaration  function CreateFindDialog: PDialog;
  20.  
  21.           Function  Constructs and returns a pointer to the
  22.                     standard text search dialog box used by
  23.                     StdEditorDialog. If you want to customize
  24.                     the simpler editor dialog boxes but still
  25.                     use the standard text search interface,
  26.                     your editor dialog box function should
  27.                     execute the dialog box returned by
  28.                     CreateFindDialog for a Dialog parameter
  29.                     of edFind.
  30.  
  31.           See also  EditorDialog variable, edXXXX constants,
  32.                     StdEditorDialog function
  33.  
  34.  
  35.  
  36. =============================================================
  37. CreateReplaceDialog function                          Editors
  38. =============================================================
  39.  
  40.        Declaration  function CreateReplaceDialog: PDialog;
  41.  
  42.           Function  Constructs and returns a pointer to the
  43.                     standard text search-and-replace dialog
  44.                     box used by StdEditorDialog. If you want
  45.                     to customize the simpler editor dialog
  46.                     boxes but still use the standard text
  47.                     search interface, your editor dialog box
  48.                     function should execute the dialog box
  49.                     returned by CreateReplaceDialog for a
  50.                     Dialog parameter of edReplace.
  51.  
  52.           See also  EditorDialog variable, edXXXX constants,
  53.                     StdEditorDialog function
  54.  
  55.  
  56.  
  57. =============================================================
  58. FailSysErrors variable                                Drivers
  59. =============================================================
  60.  
  61.        Declaration  FailSysErrors: Boolean = False;
  62.  
  63.                     If True, causes the system error handler
  64.                     to behave as if the user had responded to
  65.                     a system error message by pressing Esc.
  66.                     Normally, the system error handler
  67.                     displays a message on the last line of
  68.                     the screen and waits for user input.
  69.                     Setting FailSysErrors to True causes the
  70.                     system error handler to bypass the
  71.                     message and user prompt, and just return
  72.                     as if the DOS call that produced the
  73.                     error failed.
  74.  
  75.           See also  SysErrorFunc variable
  76.  
  77.  
  78.  
  79. =============================================================
  80. GetCtrlChar function                                  Drivers
  81. =============================================================
  82.  
  83.        Declaration  function GetCtrlChar(KeyCode: Word):
  84.                     Char;
  85.  
  86.           Function  Returns the character, Ch, for which
  87.                     Ctrl+Ch produces the 2-byte scan code
  88.                     given by the argument KeyCode. Gives the
  89.                     reverse mapping to GetCtrlCode.
  90.  
  91.           See also  GetCtrlCode
  92.  
  93.  
  94.  
  95. =============================================================
  96. GetCtrlCode function                                  Drivers
  97. =============================================================
  98.  
  99.        Declaration  function GetCtrlCode(Ch: Char): Word;
  100.  
  101.           Function  Returns the 2-byte scan code (keycode)
  102.                     corresponding to Ctrl+Ch. This function
  103.                     gives the reverse mapping to GetCtrlChar.
  104.  
  105.           See also  GetCtrlChar
  106.  
  107.  
  108.  
  109. =============================================================
  110. GetShiftState function                                Drivers
  111. =============================================================
  112.  
  113.        Declaration  function GetShiftState: Byte;
  114.  
  115.           Function  Returns a byte containing the current
  116.                     Shift key state, as reported by DOS. The
  117.                     return value contains a combination of
  118.                     the kbXXXX constants for shift states.
  119.  
  120.                     You should call GetShiftState instead of
  121.                     checking the ShiftState variable
  122.                     directly. ShiftState is not guaranteed to
  123.                     be valid in protected mode, but
  124.                     GetShiftState returns the correct value
  125.                     in either real or protected mode.
  126.  
  127.           See also  kbXXXX constants
  128.  
  129.  
  130.  
  131. =============================================================
  132. RegisterMenus procedure                                 Menus
  133. =============================================================
  134.  
  135.        Declaration  procedure RegisterMenus;
  136.  
  137.           Function  Calls RegisterType for each of the object
  138.                     types defined in the Menus unit:
  139.                     TMenuBar, TMenuBox, TMenuPopup, and
  140.                     TStatusLine. After calling RegisterMenus,
  141.                     your application can read or write any of
  142.                     those types with streams.
  143.  
  144.           See also  RegisterType procedure
  145.  
  146.  
  147.  
  148. =============================================================
  149. RegisterViews procedure                                 Views
  150. =============================================================
  151.  
  152.        Declaration  procedure RegisterViews;
  153.  
  154.           Function  Calls RegisterType for each of the object
  155.                     types defined in the Views unit: TView,
  156.                     TFrame, TScrollBar, TScroller,
  157.                     TListViewer, TGroup, and TWindow. After
  158.                     calling RegisterViews, your application
  159.                     can read or write any of those types with
  160.                     streams.
  161.  
  162.           See also  RegisterType procedure
  163.  
  164.  
  165.  
  166. =============================================================
  167. ShiftState variable                                   Drivers
  168. =============================================================
  169.  
  170.                     Although this variable exists to maintain
  171.                     compatibility with version 1.0, you
  172.                     should not check ShiftState directly.
  173.                     Rather, you should call GetShiftState,
  174.                     which returns a valid set of shift state
  175.                     flags in either real or protected mode.
  176.  
  177.  
  178.  
  179. =============================================================
  180. TDesktop                                                  App
  181. =============================================================
  182.  
  183.                     TDesktop has two additional methods not
  184.                     documented.
  185.  
  186.  
  187.            Methods  =========================================
  188.  
  189.  
  190.               Load  constructor Load(var S: TStream);
  191.  
  192.                     Constructs and loads a desktop object
  193.                     from the stream S by first calling the
  194.                     Load constructor inherited from TGroup,
  195.                     then calling GetSubViewPtr to set up the
  196.                     Background field, then reading the
  197.                     TileColumnsFirst field.
  198.  
  199.                     See also: TGroup.Load,
  200.                     TGroup.GetSubViewPtr
  201.  
  202.  
  203.              Store  procedure Store(var S: TStream);
  204.  
  205.                     Writes the desktop object to the stream S
  206.                     by first calling the Store method
  207.                     inherited from TGroup, then calling
  208.                     PutSubViewPtr to store the Background
  209.                     field, then writing the value of
  210.                     TileColumnsFirst.
  211.  
  212.                     See also: TGroup.Store,
  213.                     TGroup.PutSubViewPtr
  214.  
  215.  
  216.  
  217. =============================================================
  218. TMemoryStream                                         Objects
  219. =============================================================
  220.  
  221.                     TMemoryStream implements a stream in heap
  222.                     memory.
  223.                     The mechanics of using memory streams are
  224.                     simple. You construct a memory stream,
  225.                     specifying its initial size and a block
  226.                     size. The memory stream allocates as many
  227.                     blocks on the heap as needed to meet the
  228.                     initial size. Bytes stored on the stream
  229.                     are not guaranteed to be in contiguous
  230.                     memory locations unless the stream
  231.                     consists of a single block.
  232.  
  233.                     Once you construct the stream, you use it
  234.                     like any other. Writing beyond the end of
  235.                     the stream causes the stream to grow in
  236.                     increments of the initial block size, up
  237.                     to a maximum of 16,384 blocks.
  238.  
  239.                     Changing the size of a memory stream by
  240.                     enlarging or truncating could seriously
  241.                     fragment your heap. Try to set the
  242.                     initial size and block size of the stream
  243.                     to reasonable values to minimize
  244.                     individual allocations.
  245.  
  246.  
  247.             Fields  =========================================
  248.  
  249.          BlockSize  BlockSize: Integer;
  250.  
  251.                     The size of each block allocated to the
  252.                     memory stream.
  253.  
  254.             CurSeg  CurSeg: Integer;
  255.  
  256.                     Holds the segment part of the address of
  257.                     the block that contains the current
  258.                     stream position.
  259.  
  260.           Position  Position: Longint;
  261.  
  262.                     The position of the stream in bytes. The
  263.                     first position is 0.
  264.  
  265.           SegCount  SegCount: Integer;
  266.  
  267.                     The number of blocks currently allocated
  268.                     to the memory stream.
  269.  
  270.            SegList  SegList: PWordArray;
  271.  
  272.                     Contains the list of segment parts used
  273.                     by each allocated block. The entries
  274.                     0..SegCount-1 contain valid segments.
  275.  
  276.               Size  Size: Longint;
  277.  
  278.                     The size of the stream in bytes.
  279.  
  280.  
  281.            Methods  =========================================
  282.  
  283.               Init  constructor Init(ALimit: Longint;
  284.                     ABlockSize: Word);
  285.  
  286.                     Constructs a memory stream object by
  287.                     first calling the Init constructor
  288.                     inherited from TStream, then allocates
  289.                     enough blocks of size ABlockSize to
  290.                     collectively contain ALimit bytes. Sets
  291.                     BlockSize to ABlockSize.
  292.  
  293.                     See also: TStream.Init
  294.  
  295.               Done  destructor Done; virtual;
  296.  
  297.                     Disposes of the memory stream object by
  298.                     disposing of the memory allocated to the
  299.                     stream, then calling the Done destructor
  300.                     inherited from TStream.
  301.  
  302.                     See also: TStream.Done
  303.  
  304.             GetPos  function GetPos: Longint; virtual;
  305.  
  306.                     Returns the stream's current position.
  307.                     The first position is 0.
  308.  
  309.            GetSize  function GetSize: Longint; virtual;
  310.  
  311.                     Returns the size of the stream in bytes.
  312.  
  313.               Read  procedure Read(var Buf; Count: Word);
  314.                     virtual;
  315.  
  316.                     Reads Count bytes from the stream,
  317.                     starting at the current position, into
  318.                     the buffer Buf.
  319.  
  320.               Seek  procedure Seek(Pos: Longint); virtual;
  321.  
  322.                     Sets the current position to Pos bytes
  323.                     from the start of the stream. The first
  324.                     position is 0.
  325.  
  326.           Truncate  procedure Truncate; virtual;
  327.  
  328.                     Deletes all data on the stream from the
  329.                     current position to the end. Sets the
  330.                     current position to the new end of the
  331.                     stream.
  332.  
  333.              Write  procedure Write(var Buf; Count: Word);
  334.                     virtual;
  335.  
  336.                     Writes Count bytes from the buffer Buf to
  337.                     the stream, starting at the current
  338.                     position.
  339.  
  340.  
  341.  
  342. =============================================================
  343. TStringList                                           Objects
  344. =============================================================
  345.  
  346.                     In the example code in the Load
  347.                     constructor description, TBufStream
  348.                     should be PBufStream.
  349.  
  350.  
  351.  
  352. =============================================================
  353. TStrListMaker                                         Objects
  354. =============================================================
  355.  
  356.                     In the example code in the description of
  357.                     how to use the string list maker,
  358.                     TBufStream should be PBufStream.
  359.